Google Git
Sign in
chromium / external / w3c / web-platform-tests / 2ff1b3919612b11c1ad2c29768b0845cdd719f33 / . / webrtc / RTCRtpTransceiver-setCodecPreferences.html
blob: 8142132a8c32f3a72cb65d07c0dee7cecc3c867b [file] [log] [blame]
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]1<!doctype html>
2<meta charset=utf-8>
3<title>RTCRtpTransceiver.prototype.setCodecPreferences</title>
4<script src="/resources/testharness.js"></script>
5<script src="/resources/testharnessreport.js"></script>
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]6<script src="./third_party/sdp/sdp.js"></script>
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]7<script>
8 'use strict';
9
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]10 test((t) => {
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]11 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]12 t.add_cleanup(() => pc.close());
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]13 const transceiver = pc.addTransceiver('audio');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]14 const capabilities = RTCRtpReceiver.getCapabilities('audio');
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]15 transceiver.setCodecPreferences(capabilities.codecs);
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]16 }, `setCodecPreferences() on audio transceiver with codecs returned from RTCRtpReceiver.getCapabilities('audio') should succeed`);
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]17
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]18 test((t) => {
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]19 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]20 t.add_cleanup(() => pc.close());
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]21 const transceiver = pc.addTransceiver('video');
22 const capabilities = RTCRtpReceiver.getCapabilities('video');
23 transceiver.setCodecPreferences(capabilities.codecs);
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]24 }, `setCodecPreferences() on video transceiver with codecs returned from RTCRtpReceiver.getCapabilities('video') should succeed`);
25
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]26 test((t) => {
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]27 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]28 t.add_cleanup(() => pc.close());
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]29 const transceiver = pc.addTransceiver('audio');
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]30 transceiver.setCodecPreferences([]);
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]31 }, `setCodecPreferences([]) should succeed`);
32
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]33 test((t) => {
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]34 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]35 t.add_cleanup(() => pc.close());
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]36 const transceiver = pc.addTransceiver('audio');
phancke@microsoft.com079a2cb2024-02-27 11:06:19[diff] [blame]37 const capabilities = RTCRtpReceiver.getCapabilities('audio');
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]38 const { codecs } = capabilities;
39
40 if(codecs.length >= 2) {
41 const tmp = codecs[0];
42 codecs[0] = codecs[1];
43 codecs[1] = tmp;
44 }
45
46 transceiver.setCodecPreferences(codecs);
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]47 }, `setCodecPreferences() with reordered codecs should succeed`);
48
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]49 test((t) => {
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]50 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]51 t.add_cleanup(() => pc.close());
Harald Alvestrand3130f022020-02-06 10:50:27[diff] [blame]52 const transceiver = pc.addTransceiver('video');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]53 const capabilities = RTCRtpReceiver.getCapabilities('video');
Harald Alvestrand3130f022020-02-06 10:50:27[diff] [blame]54 const { codecs } = capabilities;
55 // This test verifies that the mandatory VP8 codec is present
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]56 // and can be preferred.
57 const codec = codecs.find(c => c.mimeType === 'video/VP8');
58 assert_true(!!codec, 'VP8 video codec was found');
59 transceiver.setCodecPreferences([codec]);
youennfb8ff0872020-09-03 08:35:01[diff] [blame]60 }, `setCodecPreferences() with only VP8 should succeed`);
61
62 test(() => {
63 const pc = new RTCPeerConnection();
64 const transceiver = pc.addTransceiver('video');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]65 const capabilities = RTCRtpReceiver.getCapabilities('video');
youennfb8ff0872020-09-03 08:35:01[diff] [blame]66 const { codecs } = capabilities;
67 // This test verifies that the mandatory H264 codec is present
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]68 // and can be preferred.
69 const codec = codecs.find(c => c.mimeType === 'video/H264');
70 assert_true(!!codec, 'H264 video codec was found');
71 transceiver.setCodecPreferences([codec]);
youennfb8ff0872020-09-03 08:35:01[diff] [blame]72 }, `setCodecPreferences() with only H264 should succeed`);
73
74 async function getRTPMapLinesWithCodecAsFirst(firstCodec)
75 {
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]76 const codecs = RTCRtpReceiver.getCapabilities('video').codecs;
77 codecs.forEach((codec, idx) => {
youennfb8ff0872020-09-03 08:35:01[diff] [blame]78 if (codec.mimeType === firstCodec) {
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]79 codecs.splice(idx, 1);
80 codecs.unshift(codec);
youennfb8ff0872020-09-03 08:35:01[diff] [blame]81 }
82 });
83
84 const pc = new RTCPeerConnection();
85 const transceiver = pc.addTransceiver('video');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]86 transceiver.setCodecPreferences(codecs);
youennfb8ff0872020-09-03 08:35:01[diff] [blame]87 const offer = await pc.createOffer();
88
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]89 return offer.sdp.split('\r\n').filter(line => line.startsWith('a=rtpmap:'));
youennfb8ff0872020-09-03 08:35:01[diff] [blame]90 }
91
92 promise_test(async () => {
93 const lines = await getRTPMapLinesWithCodecAsFirst('video/H264');
94
95 assert_greater_than(lines.length, 1);
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]96 assert_true(lines[0].indexOf('H264') !== -1, 'H264 should be the first codec');
youennfb8ff0872020-09-03 08:35:01[diff] [blame]97 }, `setCodecPreferences() should allow setting H264 as first codec`);
98
99 promise_test(async () => {
100 const lines = await getRTPMapLinesWithCodecAsFirst('video/VP8');
101
102 assert_greater_than(lines.length, 1);
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]103 assert_true(lines[0].indexOf('VP8') !== -1, 'VP8 should be the first codec');
youennfb8ff0872020-09-03 08:35:01[diff] [blame]104 }, `setCodecPreferences() should allow setting VP8 as first codec`);
Harald Alvestrand3130f022020-02-06 10:50:27[diff] [blame]105
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]106 test((t) => {
Harald Alvestrand3130f022020-02-06 10:50:27[diff] [blame]107 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]108 t.add_cleanup(() => pc.close());
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]109 const transceiver = pc.addTransceiver('audio');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]110 const capabilities = RTCRtpReceiver.getCapabilities('video');
Stephen McGruerd5103042020-01-23 21:45:45[diff] [blame]111 assert_throws_dom('InvalidModificationError', () => transceiver.setCodecPreferences(capabilities.codecs));
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]112 }, `setCodecPreferences() on audio transceiver with codecs returned from getCapabilities('video') should throw InvalidModificationError`);
113
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]114 test((t) => {
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]115 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]116 t.add_cleanup(() => pc.close());
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]117 const transceiver = pc.addTransceiver('audio');
118 const codecs = [{
119 mimeType: 'data',
120 clockRate: 2000,
121 channels: 2,
122 sdpFmtpLine: '0-15'
123 }];
124
Stephen McGruerd5103042020-01-23 21:45:45[diff] [blame]125 assert_throws_dom('InvalidModificationError', () => transceiver.setCodecPreferences(codecs));
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]126 }, `setCodecPreferences() with user defined codec with invalid mimeType should throw InvalidModificationError`);
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]127
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]128 test((t) => {
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]129 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]130 t.add_cleanup(() => pc.close());
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]131 const transceiver = pc.addTransceiver('audio');
132 const codecs = [{
133 mimeType: 'audio/piepiper',
134 clockRate: 2000,
135 channels: 2,
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]136 sdpFmtpLine: '0-15'
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]137 }];
138
Stephen McGruerd5103042020-01-23 21:45:45[diff] [blame]139 assert_throws_dom('InvalidModificationError', () => transceiver.setCodecPreferences(codecs));
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]140 }, `setCodecPreferences() with user defined codec should throw InvalidModificationError`);
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]141
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]142 test((t) => {
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]143 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]144 t.add_cleanup(() => pc.close());
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]145 const transceiver = pc.addTransceiver('audio');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]146 const capabilities = RTCRtpReceiver.getCapabilities('audio');
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]147 const codecs = [
148 ...capabilities.codecs,
149 {
150 mimeType: 'audio/piepiper',
151 clockRate: 2000,
152 channels: 2,
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]153 sdpFmtpLine: '0-15'
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]154 }];
155
Stephen McGruerd5103042020-01-23 21:45:45[diff] [blame]156 assert_throws_dom('InvalidModificationError', () => transceiver.setCodecPreferences(codecs));
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]157 }, `setCodecPreferences() with user defined codec together with codecs returned from getCapabilities() should throw InvalidModificationError`);
158
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]159 test((t) => {
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]160 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]161 t.add_cleanup(() => pc.close());
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]162 const transceiver = pc.addTransceiver('audio');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]163 const capabilities = RTCRtpReceiver.getCapabilities('audio');
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]164 const codecs = [capabilities.codecs[0]];
165 codecs[0].clockRate = codecs[0].clockRate / 2;
166
Stephen McGruerd5103042020-01-23 21:45:45[diff] [blame]167 assert_throws_dom('InvalidModificationError', () => transceiver.setCodecPreferences(codecs));
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]168 }, `setCodecPreferences() with modified codec clock rate should throw InvalidModificationError`);
169
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]170 test((t) => {
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]171 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]172 t.add_cleanup(() => pc.close());
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]173 const transceiver = pc.addTransceiver('audio');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]174 const capabilities = RTCRtpReceiver.getCapabilities('audio');
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]175 const codecs = [capabilities.codecs[0]];
176 codecs[0].channels = codecs[0].channels + 11;
177
Stephen McGruerd5103042020-01-23 21:45:45[diff] [blame]178 assert_throws_dom('InvalidModificationError', () => transceiver.setCodecPreferences(codecs));
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]179 }, `setCodecPreferences() with modified codec channel count should throw InvalidModificationError`);
180
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]181 test((t) => {
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]182 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]183 t.add_cleanup(() => pc.close());
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]184 const transceiver = pc.addTransceiver('audio');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]185 const capabilities = RTCRtpReceiver.getCapabilities('audio');
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]186 const codecs = [capabilities.codecs[0]];
187 codecs[0].sdpFmtpLine = "modifiedparameter=1";
188
Stephen McGruerd5103042020-01-23 21:45:45[diff] [blame]189 assert_throws_dom('InvalidModificationError', () => transceiver.setCodecPreferences(codecs));
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]190 }, `setCodecPreferences() with modified codec parameters should throw InvalidModificationError`);
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]191
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]192 test((t) => {
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]193 const pc = new RTCPeerConnection();
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]194 t.add_cleanup(() => pc.close());
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]195 const transceiver = pc.addTransceiver('audio');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]196 const capabilities = RTCRtpReceiver.getCapabilities('audio');
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]197
198 const { codecs } = capabilities;
199 assert_greater_than(codecs.length, 0,
200 'Expect at least one codec available');
201
202 const [ codec ] = codecs;
203 const { channels=2 } = codec;
204 codec.channels = channels+1;
205
Stephen McGruerd5103042020-01-23 21:45:45[diff] [blame]206 assert_throws_dom('InvalidModificationError', () => transceiver.setCodecPreferences(codecs));
Florent Castellidd2829c2019-05-08 15:36:36[diff] [blame]207 }, `setCodecPreferences() with modified codecs returned from getCapabilities() should throw InvalidModificationError`);
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]208
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]209 promise_test(async (t) => {
210 const pc = new RTCPeerConnection();
211 t.add_cleanup(() => pc.close());
212 const transceiver = pc.addTransceiver('audio');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]213 const {codecs} = RTCRtpReceiver.getCapabilities('audio');
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]214 // Reorder codecs, put PCMU/PCMA first.
215 let firstCodec;
216 let i;
217 for (i = 0; i < codecs.length; i++) {
218 const codec = codecs[i];
219 if (codec.mimeType === 'audio/PCMU' || codec.mimeType === 'audio/PCMA') {
220 codecs.splice(i, 1);
221 codecs.unshift(codec);
222 firstCodec = codec.mimeType.substr(6);
223 break;
224 }
225 }
226 assert_not_equals(firstCodec, undefined, 'PCMU or PCMA codec not found');
227 transceiver.setCodecPreferences(codecs);
228
229 const offer = await pc.createOffer();
230 const mediaSection = SDPUtils.getMediaSections(offer.sdp)[0];
231 const rtpParameters = SDPUtils.parseRtpParameters(mediaSection);
232 assert_equals(rtpParameters.codecs[0].name, firstCodec);
233 }, `setCodecPreferences() modifies the order of audio codecs in createOffer`);
234
235 promise_test(async (t) => {
236 const pc = new RTCPeerConnection();
237 t.add_cleanup(() => pc.close());
238 const transceiver = pc.addTransceiver('video');
Blink WPT Botf664d062024-02-13 19:51:06[diff] [blame]239 const {codecs} = RTCRtpReceiver.getCapabilities('video');
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]240 // Reorder codecs, swap H264 and VP8.
241 let vp8 = -1;
242 let h264 = -1;
243 let firstCodec;
244 let i;
245 for (i = 0; i < codecs.length; i++) {
246 const codec = codecs[i];
youennff8d620c2022-07-29 15:11:26[diff] [blame]247 if (codec.mimeType === 'video/VP8' && vp8 === -1) {
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]248 vp8 = i;
249 if (h264 !== -1) {
250 codecs[vp8] = codecs[h264];
251 codecs[h264] = codec;
252 firstCodec = 'VP8';
253 break;
254 }
255 }
youennff8d620c2022-07-29 15:11:26[diff] [blame]256 if (codec.mimeType === 'video/H264' && h264 === -1) {
Philipp Hanckeef0384e2020-09-07 09:12:42[diff] [blame]257 h264 = i;
258 if (vp8 !== -1) {
259 codecs[h264] = codecs[vp8];
260 codecs[vp8] = codec;
261 firstCodec = 'H264';
262 break;
263 }
264 }
265 }
266 assert_not_equals(firstCodec, undefined, 'VP8 and H264 codecs not found');
267 transceiver.setCodecPreferences(codecs);
268
269 const offer = await pc.createOffer();
270 const mediaSection = SDPUtils.getMediaSections(offer.sdp)[0];
271 const rtpParameters = SDPUtils.parseRtpParameters(mediaSection);
272 assert_equals(rtpParameters.codecs[0].name, firstCodec);
273 }, `setCodecPreferences() modifies the order of video codecs in createOffer`);
274
Philipp Hancke89d651c2024-02-21 12:06:07[diff] [blame]275 // Tests the note removed as result of discussion in
276 // https://github.com/w3c/webrtc-pc/issues/2933
277 promise_test(async (t) => {
278 const pc1 = new RTCPeerConnection();
279 t.add_cleanup(() => pc1.close());
280 const pc2 = new RTCPeerConnection();
281 t.add_cleanup(() => pc2.close());
282
283 const transceiver = pc1.addTransceiver('video');
284 const {codecs} = RTCRtpReceiver.getCapabilities('video');
285 const vp8 = codecs.find(codec => codec.mimeType === 'video/VP8');
286 const h264 = codecs.find(codec => codec.mimeType === 'video/H264');
287 const thirdCodec = codecs.find(codec => ['video/VP9', 'video/AV1'].includes(codec.mimeType));
288 assert_true(!!vp8);
289 assert_true(!!h264);
290 assert_true(!!thirdCodec);
291
292 transceiver.setCodecPreferences([vp8, thirdCodec]);
293 await pc1.setLocalDescription();
294 await pc2.setRemoteDescription(pc1.localDescription);
295 const transceiver2 = pc2.getTransceivers()[0];
296 transceiver2.setCodecPreferences([h264, thirdCodec, vp8]);
297 await pc2.setLocalDescription();
298 await pc1.setRemoteDescription(pc2.localDescription);
299 const mediaSection = SDPUtils.getMediaSections(pc2.localDescription.sdp)[0];
300 const rtpParameters = SDPUtils.parseRtpParameters(mediaSection);
301 // Order is determined by pc2 but H264 is not present.
302 assert_equals(rtpParameters.codecs.length, 2);
303 assert_equals(rtpParameters.codecs[0].name, thirdCodec.mimeType.substring(6));
304 assert_equals(rtpParameters.codecs[1].name, 'VP8');
305
306 }, `setCodecPreferences() filters on receiver and prefers receiver order`);
307
Soares Chend8b19bc2017-07-19 07:44:51[diff] [blame]308 </script>